Start journey

Starts the digital journey. There are two ways for starting the journey: with an existing externalId and without the externalId. You can use your own externalId if you already have an on-going custom flow before using our journey, and you need to link the two flows. If this is not the case, you can use the method without the externalId, and we will generate the Id and store it in FTOS_DJ_Instance.

Syntax

Copy

POST <host_address>/ftosapi/digital-journeys/<digital_journey_name>/start/{externalId}

Parameter	Description
`host_address`	The URL of the FintechOS platform server.
`digital_journey_name`	The name of the digital journey.
`externalId`	The unique identifier of the digital journey (if unspecified, the response will return the GUID value).

Response

Copy

{
  "nextStep": {
    "journeyItem": "string",
    "journeyStep": "string"
  },
  "instanceId": "string",
  "externalId": "string"
}

Key	Description
`journeyItem`	The name of the form driven flow associated with the digital journey.
`journeyStep`	The name of the first step in the digital journey.
`externalId`	The unique identifier of the digital journey. If the journey is started without an externalId, an externalId will be generated automatically.
`instanceId`	The ID of the digital journey instance. If the journey is started without an externalId, the instanceId will inherit the auto-generated externalId.

Examples

Starting a Digital Journey

In this example, we start a digital journey without the externalId.

https://ftos-issue-2089.internal.fintechos.com is the URL of the FintechOS server.
TestDJApi is the name of the digital journey.
The request is successful and starts the digital journey, returning externalId 83346dc6-aa88-4ce5-8dcf-8054de978376.

Request

Copy

POST /ftosapi/digital-journeys/TestDJApi/start/
Host: ftos-issue-2089.internal.fintechos.com
Content-Type: application/json

Response

Copy

{
  "nextStep": {
    "journeyItem": "TestDJApi",
    "journeyStep": "Start"
  },
  "instanceId": "83346dc6-aa88-4ce5-8dcf-8054de978376",
  "externalId": "83346dc6-aa88-4ce5-8dcf-8054de978376"
}

Errors

HTTP code	Message	Context
404 Not Found	Cannot start another Digital Journey with external id {0}	Identical externalId, cannot start instance with the same externalId.